The object-inspect npm package is a utility for inspecting JavaScript objects. It is often used for debugging and logging purposes, as it can provide a string representation of an object, including its properties and their values, even if they are not enumerable or are symbols. It can handle various types of JavaScript values, including objects, arrays, functions, and primitives.

What are object-inspect's main functionalities?

Inspecting objects

This feature allows you to get a string representation of an object, which includes all its properties and their values.

var inspect = require('object-inspect');
var obj = { foo: 'bar', baz: 42 };
console.log(inspect(obj));

Inspecting arrays

This feature allows you to get a string representation of an array, including its elements.

var inspect = require('object-inspect');
var arr = ['foo', 'bar', 42];
console.log(inspect(arr));

Inspecting functions

This feature allows you to get a string representation of a function, including its name and the function keyword.

var inspect = require('object-inspect');
function exampleFunc() {}
console.log(inspect(exampleFunc));

Inspecting symbols

This feature allows you to get a string representation of a symbol, including its description.

var inspect = require('object-inspect');
var sym = Symbol('foo');
console.log(inspect(sym));

Inspecting non-enumerable properties

This feature allows you to inspect objects with non-enumerable properties, which are included in the string representation.

var inspect = require('object-inspect');
var obj = Object.create(null, { foo: { value: 'bar', enumerable: false } });
console.log(inspect(obj));

Other packages similar to object-inspect

object-inspect

string representations of objects in node and the browser

example

circular

var inspect = require('object-inspect');
var obj = { a: 1, b: [3,4] };
obj.c = obj;
console.log(inspect(obj));

dom element

var inspect = require('object-inspect');

var d = document.createElement('div');
d.setAttribute('id', 'beep');
d.innerHTML = '<b>wooo</b><i>iiiii</i>';

console.log(inspect([ d, { a: 3, b : 4, c: [5,6,[7,[8,[9]]]] } ]));

output:

[ <div id="beep">...</div>, { a: 3, b: 4, c: [ 5, 6, [ 7, [ 8, [ ... ] ] ] ] } ]

methods

var inspect = require('object-inspect')

var s = inspect(obj, opts={})

Return a string s with the string representation of obj up to a depth of opts.depth.

Additional options:

quoteStyle: must be "single" or "double", if present. Default 'single' for strings, 'double' for HTML elements.
maxStringLength: must be 0, a positive integer, Infinity, or null, if present. Default Infinity.
customInspect: When true, a custom inspect method function will be invoked (either undere the util.inspect.custom symbol, or the inspect property). When the string 'symbol', only the symbol method will be invoked. Default true.
indent: must be "\t", null, or a positive integer. Default null.
numericSeparator: must be a boolean, if present. Default false. If true, all numbers will be printed with numeric separators (eg, 1234.5678 will be printed as '1_234.567_8')

install

With npm do:

npm install object-inspect

license

MIT

v1.13.2 - 2024-06-21

Commits

[readme] update badges 8a51e6b
[Dev Deps] update @ljharb/eslint-config, tape ef05f58
[Dev Deps] update error-cause, has-tostringtag, tape c0c6c26
[Fix] Don't throw when global is not defined d4d0965
[meta] add missing engines.node 17a352a
[Dev Deps] update globalthis 9c08884
[Dev Deps] update error-cause 6af352d
[Dev Deps] update npmignore 94e617d
[Dev Deps] update mock-property 2ac24d7
[Dev Deps] update tape 46125e5

Keywords

FAQs

What is object-inspect?

Is object-inspect popular?

Is object-inspect well maintained?

Package last updated on 22 Jun 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install